Helpful Commands

Helpful occ commands for Nextcloud

Break down of the commands

Here's a breakdown of the command components:

• sudo: Runs the command with superuser privileges. Docker commands often require such privileges to interact with the Docker daemon, which controls Docker containers and services.

• docker exec: This is a command used to run a specific command inside an already running container. It's handy when you need to interact with an application inside the container without stopping and starting it with a new command.

• -it: These are two separate options combined:

  • -i or --interactive keeps STDIN open even if not attached. This option ensures that the terminal remains interactive, meaning it can receive input from the user.
  • -t or --tty allocates a pseudo-TTY, which simulates a real terminal, like what you would have if you were logged into a shell session. This is useful for when you want the command you're executing to behave as if it's being run in a real terminal session.

• -u www-data or -u 33: This option specifies the username or UID with which to run the command inside the container. In this case, www-data is specified, indicating that the command should be executed as the www-data user. This is particularly important for applications that have permissions or actions that can only be conducted by certain users. It helps in maintaining permissions and ownership correctly within the Docker container's filesystem.

• nextcloud: This is the name or ID of the Docker container in which the command is to be executed. Docker uses this to identify which container to target for the command.

• php occ:

  • php: This specifies that the command following it should be executed with PHP, indicating a PHP script or command is being run.
  • occ: This is the Nextcloud's command-line interface (CLI) tool. occ stands for "ownCloud console," as Nextcloud forked from ownCloud. It allows administrators to perform a wide range of operations, including installing and upgrading Nextcloud, managing users, encrypting data, and much more.

Generating a redacted list of your config.php

This command will output a redacted version of your config.php file. This may make it easier for you to view and share your configuration with others without needing to manually hide the sensitive information within the file.

docker exec -it -u www-data nextcloud php occ config:list system

Reset Password

This command will allow you to reset the password for a specified user.

• user:resetpassword: A command for the occ tool that resets the password for a specified user.

• admin: The username whose password is to be reset. In this case, it's the admin user, typically the primary administrative account for Nextcloud.

sudo docker exec -it -u 33 nextcloud php occ user:resetpassword admin

Show mastercontainer password for Nextcloud AIO

sudo cat /var/lib/docker/volumes/nextcloud_aio_mastercontainer/_data/data/configuration.json | grep password

Repair Nextcloud

This specific OCC command triggers a variety of repair and maintenance tasks to ensure the Nextcloud installation is running correctly. Tasks include cleaning up the database, ensuring file cache accuracy, and other sanity checks that can resolve common issues automatically.

The maintenance:repair command is particularly useful in scenarios where Nextcloud is behaving unexpectedly, after an update that didn't complete successfully, or when recommended by Nextcloud's documentation or support forums as a step to resolve specific issues. Executing this command can help restore Nextcloud to a healthy state without directly manipulating database entries or file system structures manually, offering a safer approach to troubleshooting and system maintenance.

sudo docker exec -it -u 33 nextcloud php occ maintenance:repair

Generate Geometry Table for Memories

This specific occ command will create the Geometry Table for Nextcloud Memories. The "places-setup" will initialize data related to places, set up geotagging features, databases related to locations, and preparing the environment for managing memory-related data more effectively.

sudo docker exec -it -u 33 nextcloud php occ memories:places-setup

Adding Missing DB Indices

This is the specific OCC command used to add missing database indices to the Nextcloud's database. Database indices help improve the performance of database operations by allowing the database engine to find data more efficiently. This operation can speed up application performance, especially on larger datasets or more heavily utilized instances.

Administrators might use this command when they notice performance issues with their Nextcloud instance, after an upgrade, or upon recommendation by Nextcloud's administrative tools. Adding missing indices is a maintenance task that helps ensure the database operates efficiently, improving search times and overall responsiveness of the Nextcloud interface.

sudo docker exec -it -u 33 nextcloud php occ db:add-missing-indices

Upgrading

This specific occ command triggers the upgrade process of the Nextcloud installation to the latest version, applying any database schema updates, data migrations, and code updates necessary for the new version to function correctly. You may need to run this command if an Upgrade attempt did not finish succesfully.

sudo docker exec -it -u 33 nextcloud php occ upgrade

Maintenance Mode

--off disables maintenance mode, making the Nextcloud instance accessible to users again.

--on enables maintenance mode, making the Nextcloud instance not accessible to users.

sudo docker exec -it -u 33 nextcloud php occ maintenance:mode --off

Scan all Files

This OCC command tells Nextcloud to scan for file changes. This is useful for making sure that files added, removed, or modified directly on the filesystem (outside of Nextcloud's web or desktop clients) are correctly reflected in Nextcloud's database.

• --all: An option for the files:scan command that specifies the scan should cover files and directories of all users on the Nextcloud instance, not just a single user.

sudo docker exec -it -u 33 nextcloud php occ files:scan --all

Scan files for a specific user

sudo docker exec -it -u 33 nextcloud php occ files:scan <user>

Reset BruteForce Detection

This is a specific OCC command that resets or clears any brute force attempt entries logged against a particular IP address in Nextcloud's security mechanisms.

• <ip address>: Placeholder for the actual IP address you wish to reset the brute force protection entries for. Replace <ip address> with the specific IP address that you're targeting.

This command is particularly useful for administrators who need to unlock access for users who have been locked out of their accounts due to Nextcloud's brute force protection mechanism. This mechanism prevents unauthorized access by temporarily blocking login attempts after several failed login attempts from the same IP address. If a legitimate user is accidentally locked out due to too many failed attempts or another reason, this command allows the administrator to quickly reset the protection for that IP, restoring access for the affected user.

sudo docker exec -it -u 33 nextcloud php occ security:bruteforce:reset <ip address>

Resources

Reset Nextcloud Password
Show Nextcloud AIO Admin Panel Password